GitHub Advanced Securityの主要な3つの機能を試してみた

こんにちは、豊島です。

はじめに

GitHub Advanced Securityの3つの主要な機能(Dependabot、コードスキャン、シークレットスキャン)を試してみました。

GitHub Advanced Securityの主要な3つの機能について

• そもそもGitHub Advanced Security(以下GHAS)とは

GitHub Advanced Security (GHAS) は、開発者を支援するアプリケーションセキュリティソリューションです。 Advanced Securityはワークフローに直接組み込まれているため、開発を遅らせることなく、脆弱性と資格情報の漏洩を防ぐことができます。 GitHub Advanced Security は、専属のセキュリティコンサルタントに、世界中のセキュリティ専門家の分析情報を使って、すべてのコード行を確認してもらうようなものです。

GHAS とは

各ソリューションを表にまとめてみました

それぞれの設定を確認

リポジトリの画像を例に設定しています
Securityタブから

• Dependabot alerts
• Code scanning alerts
• Secret scanning alerts

がEnableになっていることを確認します（デフォルトではSecret scanning alertsのみEnableになっていますね）

設定後

Dependabotを試してみる

すでにDependabotのアラートが3つあがっているため、#1から確認していきます

Create Dependabot security updateからプルリクエストを作成していきます

右側にSeverity(重大度の評価とスコア)といったメタデータが表示されています
詳細を知りたい方はDependabot アラートのメタデータについてを参照ください

作成できたようなので、Review security updateから確認します。

問題がなければマージしましょう（マージ後にアラートが消えていました）

続けて#2も同様に実施します。

Create中に失敗しました。どうやら他のパッケージとの依存関係が原因のようです。
しかし内容をよく見るとnextのバージョンが14.2.10であればOKなため、package.jsonのバージョンを変えてマニュアルでインストールしてみたところアラートが消えました。

今回はパブリックリポジトリを対象に適用しましたが、GitHub Enterprise Cloud (GHEC)と組み合わせることでプライベートリポジトリにも適用することができます

コードスキャンを試してみる

演習用のリポジトリで試していきます

まずはそれぞれの設定がEnableになっていることを確認していきます
SettingsタブのSecurity Code securityから

ToolsのCodeQL analysisをDefaultで設定していきます

今回はデフォルトのまま設定していきます

ActionsのCodeQL Setupが完了になっていることを確認します

SecurityタブのCode Scanningに2件あがってきています

（ここから演習順序から外れます）
alertの詳細を見るとRecommendationやExampleから修正の手助けができるようになっています
今回は上部にあるCopilot Autofixを試してみたのですが、変更内容を自動で作成してくれる機能のようです

プルリクエスト作成時にもCodeQLが実行され、変更内容を含めた評価が実行されています

マージ後に、alertは消えています

シークレットスキャンを試してみる

演習用のリポジトリで試していきます

まずはそれぞれの設定がEnableになっていることを確認していきます
SettingsタブのSecurity Code securityから

Secret scanningとPush protectionがEnableであることを確認します

SecurityのSecret Scanningから検出済みのSecret情報を確認することができます。

Validityでシークレットが有効かどうかをチェックすることができます。流出してしまったシークレットが"active","inactive","Unknown"かをチェックし、対応の優先順位付けに役立ちます。

Secret typeでシークレットの種別をフィルターすることができます

アラートの内容からはSecret typeごとに具体的な対応方法が記載されています（写真はAWSのため）

プッシュ保護が有効化されているため、コンソール上からコミットしようとしたところポップアップが出ました。

具体的な箇所、意図したものであるかどうかの確認が出ています。これらを選択することでAllow Secretからプッシュ可能でした。

エディタから同様にプッシュしたところ、エラーが発生しました。

> git push origin main:main
remote: error: GH013: Repository rule violations found for refs/heads/main.
remote:
remote: - GITHUB PUSH PROTECTION
remote:   —————————————————————————————————————————
remote:     Resolve the following violations before pushing again
remote:
remote:     - Push cannot contain secrets
remote:
remote:
remote:      (?) Learn how to resolve a blocked push
remote:      https://docs.github.com/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line#resolving-a-blocked-push
remote:
remote:
remote:       —— GitHub Personal Access Token ——————————————————————
remote:        locations:
remote:          - commit: 5af768990df6b081e2c598286ba7d99d0629806a
remote:            path: credentials.yml:6
remote:
remote:        (?) To push, remove secret from commit(s) or follow this URL to allow the secret.
remote:        https://github.com//skills-introduction-to-secret-scanning/security/secret-scanning/unblock-secret/2pNZmKbaYbFAvnuv2OsX3IUlHwq
remote:
remote:
remote:
To https://github.com//skills-introduction-to-secret-scanning.git
 ! [remote rejected] main -> main (push declined due to repository rule violations)
error: failed to push some refs to 'https://github.com//skills-introduction-to-secret-scanning.git'